/*
 * Copyright 2002-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.beans.factory.config;

import org.springframework.lang.Nullable;

/**
 * Interface that defines a registry for shared bean instances.
 * Can be implemented by {@link org.springframework.beans.factory.BeanFactory}
 * implementations in order to expose their singleton management facility
 * in a uniform manner.
 *
 * <p>The {@link ConfigurableBeanFactory} interface extends this interface.
 *
 * @author Juergen Hoeller
 * @since 2.0
 * @see ConfigurableBeanFactory
 * @see org.springframework.beans.factory.support.DefaultSingletonBeanRegistry
 * @see org.springframework.beans.factory.support.AbstractBeanFactory
 *
 * Spring容器对单例bean实例的登记管理主要通过接口SingletonBeanRegistry建模抽象，
 * 我们可以称之为"单例bean实例注册表"。
 *
 * 该接口约定了实现者(一般指容器)具有如下能力 :
 * 1、注册登记将创建完成的单例bean实例;
 * 2、获取某个指定名称的单例bean实例;
 * 3、检测是否已经注册登记了某个指定名称的单例bean实例;
 * 4、获取所有单例bean实例的名称;
 * 5、获取注册登记的所有单例bean实例的数量;
 * 6、获取当前单例bean实例注册表的互斥量(mutex),供外部使用者协作(collaborator)使用
 *
 */
public interface SingletonBeanRegistry {

	/**
	 * 以指定的名字将给定Object注册到BeanFactory中。
	 * 此接口相当于直接把Bean注册，所以都是准备好了的Bean。（动态的向容器里直接放置一个Bean）
	 * 什么BeanPostProcessor、InitializingBean、afterPropertiesSet等都不会被执行的，销毁的时候也不会收到destroy的信息
	 */
	void registerSingleton(String beanName, Object singletonObject);

	/**
	 * 返回已经初始化完成的Bean，对于还没有初始化的Bean Definition不予以考虑
	 * 需要注意的是：此方法不能直接通过别名获取Bean。
	 * 如果只有别名的话，要先通过BeanFactory的接口获取到Bean对应的全限定名称
	 */
	@Nullable
	Object getSingleton(String beanName);

	/**
	 * 是否包含已经始化完成的Bean（不支持通过别名查找）
	 */
	boolean containsSingleton(String beanName);

	/**
	 * 从注册表中获取所有的已经初始化完成的Bean名字
	 */
	String[] getSingletonNames();

	/**
	 *返回注册表中内注册的单例类数量
	 */
	int getSingletonCount();

	/**
	 *  获取当前这个注册表的互斥量(mutex),使用者通过该互斥量协同访问当前注册表（用于并发控制）
	 */
	Object getSingletonMutex();

}
